Apple Pay API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様(.idPass)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却

EntryTranBrandtoken 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

JobCd 必須
処理区分
  • CAPTURE:即時売上
  • AUTH:仮売上

ItemCode 半角英数7桁
商品コード

通常は省略してください。カード会社から指定がある場合のみ、その値を設定します。省略時は0000990を適用します。
加盟店様で管理されている商品のコード等を設定されないよう、ご注意ください。

Amount 必須 半角数字7桁
利用金額

Tax 半角数字7桁
税送料

URL
/payment/EntryTranBrandtoken.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=CAPTURE&Amount=1000
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranBrandtoken 決済実行

オーソリを実行します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

TokenType 半角英数8桁
トークン種別

利用するトークンの取得元を設定します。
現在、以下のコードに対応しています。
"APay"

Token
トークン

端末から取得したトークンを設定してください。
TokenTypeが"APay"の場合:
端末で取得したpaymentトークンをbase64エンコードして送信してください。
※トークンが指定された場合、TokenTypeは必須となり、SiteID,SitePass,MemberIDは無視されます。

SiteID 半角英数13桁
サイトID

SitePass 半角英数10桁
サイトパスワード

MemberID 半角英数60桁
会員ID

SeqMode 半角数字1桁 固定
連番モード

0:論理(省略値)
1:物理
利用するトークンの連番指定モード。

TokenSeq 半角数字4桁
トークン連番

複数トークンを登録している会員について、どのトークンを利用するか番号で指定します。省略した
場合、トークンの登録時に指定したDefaultFlagが指定されたものを利用します。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

URL
/payment/ExecTranBrandtoken.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
Status 半角英数16桁
取引状態

決済実行された結果の状態を返却します。
"AUTH":仮売上
"CAPTURE":即時売上
"UNPROCESSED":未決済(決済失敗)

OrderID 半角英数記号27桁
オーダーID

Forward 半角英数7桁
仕向先コード

与信を行ったカード会社の会社コードを返却します。

Approve 半角英数7桁
承認番号

カード会社が発行した与信の承認番号を返却します。

TranID 半角英数28桁
トランザクションID

弊社が処理を行う毎に発行している処理番号を返却します。

TranDate 半角数字14桁 固定
決済日付

【決済実行】を実施した日時を返却します。(yyyyMMddHHmmss形式)

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
Status=AUTH&OrderID=ORDER0000001&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113011&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

VoidTranBrandtoken 決済取消

一度オーソリ取得した取引に対し、与信枠を取り消します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

URL
/payment/VoidTranBrandtoken.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Status 半角英数16桁
取引状態

【決済取消】を実行した結果の取引ステータスです。
"VOID":取消
※処理に失敗した場合、決済取消要求前の状態が返却されます。

Forward 半角英数7桁
仕向先コード

与信を行ったカード会社の会社コードを返却します。

Approve 半角英数7桁
承認番号

カード会社が発行した与信の承認番号を返却します。

TranID 半角英数28桁
トランザクションID

当社が処理を行う毎に発行している処理番号を返却します。

TranDate 半角数字14桁 固定
決済日付

与信を実施した日付を返却します。
(yyyyMMddHHmmss形式)

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Status=VOID&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113012
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SalesTranBrandtoken 売上確定

オーソリ済の取引に対し、売上の確定を行います。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字7桁
確定金額

【取引登録】で指定した値を設定します。
オーソリ金額から増額/減額した確定はできません。

Tax 半角数字7桁
確定税送料

【取引登録】で指定した値を設定します。
オーソリ金額から増額/減額した確定はできません。

URL
/payment/SalesTranBrandtoken.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Status 半角英数16桁
取引状態

【実売上】を実行した結果の取引ステータスです。
"SALES":実売上
※確定に失敗した場合、確定要求前の状態が返却されます。

Forward 半角英数7桁
仕向先コード

与信を行ったカード会社の会社コードを返却します。

Approve 半角英数7桁
承認番号

カード会社が発行した与信の承認番号を返却します。

TranID 半角英数28桁
トランザクションID

当社が処理を行う毎に発行している処理番号を返却します。

TranDate 半角数字14桁 固定
決済日付

与信を実施した日付を返却します。
(yyyyMMddHHmmss形式)

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Status=SALES&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113012
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

RefundTranBrandtoken 返金

売上確定済の取引に対し、返品処理を行います。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字7桁
返品金額

【取引登録】で指定した値を設定します。
確定時から減額/増額した返品はできません。

Tax 半角数字7桁
返品税送料

【取引登録】で指定した値を設定します。
確定時から減額/増額した返品はできません。

URL
/payment/RefundTranBrandtoken.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Status 半角英数16桁
取引状態

【返品】を実行した結果の取引ステータスです。
"RETURN":返品
※返品に失敗した場合、返品要求前の状態が返却されます。

Forward 半角英数7桁
仕向先コード

与信を行ったカード会社の会社コードを返却します。

Approve 半角英数7桁
承認番号

カード会社が発行した与信の承認番号を返却します。

TranID 半角英数28桁
トランザクションID

当社が処理を行う毎に発行している処理番号を返却します。

TranDate 半角数字14桁 固定
決済日付

与信を実施した日付を返却します。
(yyyyMMddHHmmss形式)

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Status=RETURN&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113012
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

ChangeTranBrandtoken 金額変更

決済が完了した取引に対し、金額の変更を行います。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

JobCd 必須
処理区分

Amount 必須 半角数字7桁
利用金額

Tax 半角数字7桁
税送料

URL
/payment/ChangeTranBrandtoken.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&JobCd=&Amount=1000
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Status 半角英数16桁
取引状態

【金額変更】を実行した結果の取引ステータスです。
"RETURN":返品
※返品に失敗した場合、返品要求前の状態が返却されます。

Forward 半角英数7桁
仕向先コード

与信を行ったカード会社の会社コードを返却します。

Approve 半角英数7桁
承認番号

カード会社が発行した与信の承認番号を返却します。

TranID 半角英数28桁
トランザクションID

当社が処理を行う毎に発行している処理番号を返却します。

TranDate 半角数字14桁 固定
決済日付

与信を実施した日付を返却します。
(yyyyMMddHHmmss形式)

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Status=RETURN&Forward=2a99663&Approve=1602624&TranID=2208031130111111111111750389&TranDate=20220803113012
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

TradedBrandtoken 取引後トークン登録

指定した会員にApplePay(ブランドトークン)情報を登録します。

リクエスト
SiteID 必須 半角英数13桁
サイトID

SitePass 必須 半角英数10桁
サイトパスワード

MemberID 必須 半角英数記号60桁
会員ID

ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

DefaultFlag 半角英数1桁 固定
デフォルトフラグ

0:デフォルトとしない(省略値)
1:デフォルトとする
1会員に複数のトークンを登録した場合、優先的に利用されるカードとして設定します。複数のトークンを登録している会員が決済する場合、連番を省略した場合に利用します。

SeqMode 半角英数10桁
連番モード

0:論理(省略値)
1:物理
登録結果の連番を出力する際の、出力モードです。
連番とは、1会員に複数のトークンを設定した場合に、トークンを指し示す番号です。
論理番号は、常に0から始まります。トークンを削除した場合には、有効なトークンについて0から振りなおします。
物理番号は、登録した際に採番された値を常に用います。

TokenSeq 半角数字4桁
トークン連番

更新対象のトークン連番を指定します。連番モードで1(物理)を指定した場合のみ有効です。
指定しない場合は新規トークンとして登録します。

URL
/payment/TradedBrandtoken.idPass
リクエストパラメータ
SiteID=tsite99887701&SitePass=PASSWORD&MemberID=Member00&ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001
レスポンス
正常
TokenSeq 半角数字4桁
トークン連番

登録した結果採番された、トークン連番を返却します。

CardNoToken 半角英数記号16桁
カード番号トークン

登録されたトークン番号を返却します。

Forward 半角英数7桁
仕向先コード

登録元になった決済の、仕向け先カード会社を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
TokenSeq=0001&CardNoToken=C1+2MnMKh7xuFkiOWHvJu7ToZo5Cp5yFrVafcPG5f2c=&Forward=2a99663
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

DeleteBrandtoken トークン削除

指定した会員のApplePay(ブランドトークン)情報を削除します。

リクエスト
SiteID 必須 半角英数13桁
サイトID

SitePass 必須 半角英数10桁
サイトパスワード

MemberID 必須 半角英数記号60桁
会員ID

SeqMode 必須 半角数字1桁 固定
連番モード

0:論理(省略値)
1:物理
削除する連番のモードを設定します。

TokenSeq 必須 半角数字4桁
トークン連番

削除するトークンの連番です。

URL
/payment/DeleteBrandtoken.idPass
リクエストパラメータ
SiteID=tsite99887814&SitePass=PASSWORD&MemberID=Member00&SeqMode=1&TokenSeq=0001
レスポンス
正常
TokenSeq 半角数字4桁
トークン連番

API呼出時に指定した値を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
TokenSeq=0001
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SearchBrandtoken トークン照会

会員に登録されているApplePay(ブランドトークン)情報を返却します。

リクエスト
SiteID 必須 半角英数13桁
サイトID

SitePass 必須 半角英数10桁
サイトパスワード

MemberID 必須 半角英数記号60桁
会員ID

SeqMode 必須 半角英数1桁
連番種別

0:論理(省略値)
1:物理
参照するトークン連番の種類です。

TokenSeq 半角数字4桁
トークン連番

参照するトークンの連番です。省略した場合、会員に登録されている全てのトークン情報を返します。
また、連番種別で1(物理)を指定した場合、削除済みを含む全量を返却します。

URL
/payment/SearchBrandtoken.idPass
リクエストパラメータ
SiteID=tsite99887814&SitePass=PASSWORD&MemberID=Member00&SeqMode=1
レスポンス
正常
TokenSeq
トークン連番

トークンの連番です。API呼び出し時のSeqModeで指定された連番を返却します。

DefaultFlag
デフォルトフラグ

トークンに設定されたデフォルトフラグを返却します。

CardName
カード名称

何も設定されません。通常クレジットカードと項目をあわせる為に設置します。

CardNoToken
カード番号トークン

トークン化されたカード番号を返却します。

Expire
カード有効期限

トークンに設定された有効期限を返却します。

HolderName
名義人

トークンに設定されたカード名義人を返却します。

DeleteFlag
削除フラグ

トークンに設定された削除フラグを返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
TokenSeq=0001&DefaultFlag=&CardName=&CardNoToken=C1+2MnMKh7xuFkiOWHvJu7ToZo5Cp5yFrVafcPG5f2c=&Expire=2208&HolderName=ヤマダタロウ&DeleteFlag=
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

取引を照会し、その状態を確認できます。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済手段

27: ApplePay(ブランドトークン)

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=27
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status 半角英数15桁
取引状態

以下のいずれかを返却します。
UNPROCESSED:未決済
CAPTURE:即時売上
AUTH:仮売上
SALES:実売上
VOID:取消
RETURN:返品

ProcessDate 半角数字14桁 固定
処理日時

処理を行った日時を返却します。
(yyyyMMddHHmmss形式)

JobCd 半角英数10桁
処理区分

以下のいずれかを返却します。
CAPTURE:即時売上
AUTH:仮売上
SALES:実売上
VOID:取消
RETURN:返品

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

ItemCode 半角英数7桁
商品コード

参照した取引に設定されている値を返却します。

Amount 半角数字7桁
利用金額

Tax 半角数字7桁
税送料

SiteID 半角英数13桁
サイトID

MemberID 半角英数60桁
会員ID

CardNoToken 半角英数16桁
カード番号トークン

トークン化されたカード番号を返却します。

Expire 半角数字4桁
有効期限

参照した取引に設定されている値を返却します。

Method 半角数字1桁 固定
支払方法

1:一括を返却します。

PayTimes 半角数字2桁
支払回数

参照した取引に設定されている値を返却します。

Forward 半角英数7桁
仕向先コード

参照した取引に設定されている値を返却します。

TranID 半角英数28桁
トランザクションID

参照した取引に設定されている値を返却します。

Approve 半角英数7桁
承認番号

参照した取引に設定されている値を返却します。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

27:ApplePay(ブランドトークン)

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
OrderID=ORDER0000001&Status=AUTH&ProcessDate=20220803113012&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&ItemCode=0000990&Amount=1000&Tax=100&SiteID=tsite99887701&MemberID=memberid001&CardNoToken=C1+2MnMKh7xuFkiOWHvJu7ToZo5Cp5yFrVafcPG5f2c=&Expire=2208&Method=1&PayTimes=&Forward=2a99663&TranID=2208031130111111111111750389&Approve=1602624&ClientField1=加盟店自由項目1 &ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=27
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

決済結果受信

取引でイベント(オーソリ、実売上等)が発生した際、当サービスからの HTTP による push通知を利用可能です。
この機能の利用は任意であり、ご利用する場合管理画面より設定します。
通知は、イベント発生後速やかに行われます。また、通知に失敗した場合、最大 5 回まで 60 分おきに再送されます。
受信した加盟店様では、受信した応答を返却してください。また、加盟店様では特に不要な通知でも、正常として応答してください。

リクエスト(当サービス⇒加盟店様)

接続先URLは、加盟店様がショップ管理画面で設定したURLとなります。

             
OrderID 半角英数記号27桁
オーダーID

【取引状態参照】の呼出時に指定した値を返却します。

Status 半角英数16桁
取引状態

以下のいずれを返却します。
UNPROCESSED:未決済
CAPTURE:即時売上
AUTH:仮売上
SALES:実売上
VOID:取消
RETURN:返品

ProcessDate 半角数字14桁 固定
処理日時

処理を行った日時を返却します。
(yyyyMMddHHmmss形式)

JobCd 半角英数10桁
処理区分

以下のいずれかを返却します。
CAPTURE:即時売上
AUTH:仮売上
SALES:実売上
VOID:取消
RETURN:返品

AccessID 半角英数32桁 固定
取引ID

参照した取引に設定されている値を返却します。

AccessPass 半角英数32桁 固定
取引パスワード

参照した取引に設定されている値を返却します。

ItemCode 半角英数7桁
商品コード

参照した取引に設定されている値を返却します。

Amount 半角数字7桁
利用金額

参照した取引に設定されている値を返却します。

SiteID 半角英数13桁
サイトID

参照した取引に設定されている値を返却します。

MemberID 半角英数60桁
会員ID

参照した取引に設定されている値を返却します。

CardNoToken 半角英数16桁
カード番号トークン

トークン化されたカード番号を返却します。

Expire 半角数字4桁
有効期限

参照した取引に設定されている値を返却します。

Method 半角数字1桁
支払方法

以下のいずれかを返却します。
1:一括
2:分割
3:ボーナス一括
5:リボ

PayTimes 半角数字2桁
支払回数

参照した取引に設定されている値を返却します。

Forward 半角英数7桁
仕向先コード

参照した取引に設定されている値を返却します。

TranID 半角英数28桁
トランザクションID

参照した取引に設定されている値を返却します。

Approve 半角英数7桁
承認番号

参照した取引に設定されている値を返却します。

     

   
   
レスポンス(加盟店様⇒当サービス)
正常
RecvRes 半角数字1桁 固定
受信結果

応答ステータス
0:正常